/*
*  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
*  reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*  1. Redistributions of source code must retain the above copyright
*  notice, this list of conditions and the following disclaimer.
*
*  2. Redistributions in binary form must reproduce the above copyright
*  notice, this list of conditions and the following discalimer in
*  the documentation and/or other materials provided with the
*  distribution.
*
*  3. The end-user documentation included with the redistribution,
*  if any, must include the following acknowledgment:
*  "This product includes software developed by the
*  Sun Microsystems, Inc. for Project JXTA."
*  Alternately, this acknowledgment may appear in the software itself,
*  if and wherever such third-party acknowledgments normally appear.
*
*  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
*  must not be used to endorse or promote products derived from this
*  software without prior written permission. For written
*  permission, please contact Project JXTA at http://www.jxta.org.
*
*  5. Products derived from this software may not be called "JXTA",
*  nor may "JXTA" appear in their name, without prior written
*  permission of Sun.
*
*  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
*  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*  DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
*  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
*  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
*  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
*  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
*  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*  SUCH DAMAGE.
*  ====================================================================
*
*  This software consists of voluntary contributions made by many
*  individuals on behalf of Project JXTA.  For more
*  information on Project JXTA, please see
*  <http://www.jxta.org/>.
*
*  This license is based on the BSD license adopted by the Apache Foundation.
*
*  $Id: DirectiveFilter.java,v 1.4 2007/01/26 21:54:26 bondolo Exp $
*/

package net.jxta.myjxta.dialog.filter;

import net.jxta.myjxta.dialog.DialogMessage;
import net.jxta.myjxta.dialog.DialogMessageWrapper;

import net.jxta.myjxta.directive.Directive;
import net.jxta.myjxta.directive.DirectiveException;
import net.jxta.myjxta.directive.DirectiveFactory;
import net.jxta.myjxta.util.Group;

import java.util.logging.Logger;

/**
 *
 * @version $Id: DirectiveFilter.java,v 1.4 2007/01/26 21:54:26 bondolo Exp $
 *
 * @author james todd [gonzo at jxta dot org]
 */

public class DirectiveFilter
extends AbstractDialogFilter {

    private static final Logger LOG = Logger.getLogger(DirectiveFilter.class.getName());

    private Group group = null;
    
    public DirectiveFilter(Group group) {
        this.group = group;
    }
    
    /**
     * If the msg text is a directive, then the direcive is processed and the supplied messages is discareded.
     * 
     * @param msg the newly received DialogMessage object
     * @return the, possibly invalidated, <code>DialogMessage</code>.  The <code>DialogMessage</code> is invalidated
     * if it is a processed directive. 
     */
    public DialogMessage filter(DialogMessage msg) {
        if (! processMessage((DialogMessageWrapper)msg)) {
            return msg;
        }
        
        Directive d = null;

        try {
            d = DirectiveFactory.get(msg, this.group);
        } catch (ClassNotFoundException ignored) {
            // Not really a directive
            return msg;
        }

        if (d != null) {
            // xxx: consider threading ... otherwise might want to inject results
            try {
                d.process();
            } catch (DirectiveException de) {
                LOG.log(java.util.logging.Level.SEVERE,
                        "Caught unexpected Exception", de);
            }

            ((DialogMessageWrapper)msg).setValid(false);
        }

        return msg;
    }
}
